Pular para o conteúdo principal

Enviar Documentos para Analises retorno de Score

Enviar documento para gerar o score na API Acertpix via MCP(Model Context Protocol).

Acesse nosso Repositório para integrar MCPs no seu Ambiente de Desenvolvimento

Body

ParâmetroDescriçãoTipoExemplosObrigatório
ChaveCampo para identificação da analiseString"ChaveDefinidaPeloCliente"Sim
ImagemFrenteCaminho para o arquivo da ImagemFrenteString"C:\Pasta\ImagemFrente.png"Sim
ImagemVersoCaminho para o arquivo da ImagemVersoString"C:\Pasta\ImagemVerso.png"Não
ImagemSelfieCaminho para o arquivo da ImagemSelfieString"C:\Pasta\ImagemSelfie.png"Não
ImagemQrCodeCaminho para o arquivo da ImagemQrCodeString"C:\Pasta\ImagemQrCode.png"Não
CPFCPF para validação em bases cadastraisString"000000000000"Não

Exemplo de input

envie este documento para gerar o Score, chave ChaveDefinidaPeloCliente, cpf 000000000000, ImagemFrente "C:\Pasta\ImagemFrente.png", ImagemVerso "C:\Pasta\ImagemVerso.png", ImagemSelfie "C:\Pasta\ImagemSelfie.png", ImagemQrCode "C:\Pasta\ImagemQrCode.png"

Status Code 200

Retorno de sucesso.

ParâmetroDescriçãoTipoExemplos
StatusStatus da requisiçãoOK = 0, ERRO = 10
MensagensDescrição dos errosString[]["SUCESSO"]

Exemplo

{
"Status": 0,
"Mensagens": [
"SUCESSO"
]
}

Status Code 401

Usuário/Senha inválidos.

ParâmetroDescriçãoTipoExemplos
StatusStatus da requisiçãoOK = 0, ERRO = 11
MensagensDescrição dos errosString[]"Mensagens": []

Status Code 404

Erro 404 - Url não encontrado

O erro 404 é exibido quando um endpoint especificado pelo usuário não é encontrado na API. Isso pode ocorrer quando o usuário digitou um URL incorreto ou quando o endpoint não está mais disponível.

Status Code 500

Erro não tratado pelo sistema.

ParâmetroDescriçãoTipoExemplos
StatusStatus da requisiçãoOK/ERROERRO
MensagensDescrição dos errosString[]"Mensagens": []

Exemplo

{
"Status": "OK",
"Mensagens": [
"string"
]
}